Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 15, 2025

Summary

What changed?

  • Updated the PR template markdown content to improve clarity and completeness of required sections.

Why is this change needed?

  • PR descriptions were frequently missing key context, slowing reviews and increasing back-and-forth.
  • The AI disclosure section is required; this update makes it harder to skip and easier to complete consistently.

Issues / work items

  • Resolves: N/A
  • Related: N/A

Project checklist

  • Release notes are not required for the next release
    • Otherwise: Notes added to release_notes.md
  • Backport is not required
    • Otherwise: Backport tracked by issue/PR #issue_or_pr
  • All required tests have been added/updated (unit tests, E2E tests)
  • Breaking change? No
    • If yes:
      • Impact: N/A
      • Migration guidance: N/A

AI-assisted code disclosure (required)

Was an AI tool used? (select one)

  • No
  • Yes, AI helped write parts of this PR (e.g., GitHub Copilot)
  • Yes, an AI agent generated most of this PR

If AI was used:

  • Tool(s): GitHub Copilot
  • AI-assisted areas/files: PR template markdown (this file)
  • What you changed after AI output: Reviewed wording for accuracy and adjusted checklist selections.

AI verification (required if AI was used):

  • I understand the code and can explain it
  • I verified referenced APIs/types exist and are correct
  • I reviewed edge cases/failure paths (timeouts, retries, cancellation, exceptions)
  • I reviewed concurrency/async behavior
  • I checked for unintended breaking or behavior changes

Testing

Automated tests

  • Result: Passed (N/A – documentation/template-only change)

Manual validation (only if runtime/behavior changed)

  • Environment (OS, .NET version, components): N/A
  • Steps + observed results:
    1. Previewed the rendered markdown to confirm formatting.
    2. Verified all sections are complete and scannable for reviewers.
    3. N/A
  • Evidence (optional): N/A

Notes for reviewers

  • This PR only updates the PR template.

Copilot AI changed the title [WIP] Add pull request template for durabletask-dotnet Add GitHub Pull Request template Dec 15, 2025
Copilot AI requested a review from torosent December 15, 2025 01:31
@torosent torosent marked this pull request as ready for review December 15, 2025 01:47
Copilot AI review requested due to automatic review settings December 15, 2025 01:47
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a comprehensive pull request template for the durabletask-dotnet repository to standardize PR submissions. The template enforces consistent structure and ensures contributors address critical aspects like testing, AI code disclosure, breaking changes, and manual validation before submission.

Key Changes

  • Added .github/PULL_REQUEST_TEMPLATE.md with structured sections covering summary, change type, AI disclosure requirements, testing expectations (both automated and manual), compatibility considerations, and author review checklist
  • Included DurableTask-specific validation scenarios for manual testing (orchestration behavior, activity execution, failure handling, cancellation flows, timers, concurrency, and backward compatibility)
  • Required AI verification checklist ensures contributors using AI tools verify correctness, edge cases, concurrency behavior, and unintended changes

@torosent torosent requested a review from halspang December 15, 2025 16:31
Copilot AI and others added 3 commits December 15, 2025 10:27
Updated the pull request template to streamline sections and improve clarity.
Removed unnecessary checklist items from PR template.
@torosent torosent force-pushed the copilot/add-github-template-durabletask-dotnet branch from 8300c3c to 8f3e1da Compare December 15, 2025 18:27
@torosent torosent merged commit 13793ad into main Dec 15, 2025
5 checks passed
@torosent torosent deleted the copilot/add-github-template-durabletask-dotnet branch December 15, 2025 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants